home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / edit / me_cd.zip / ME.DOC < prev    next >
Text File  |  1988-10-24  |  35KB  |  742 lines
  1. ========================================================================
  2. ==        ME Documentation          Craig Durland  8/88 ==
  3. ========================================================================
  4.  
  5.   ME is a small, portable, extendable Emacs like editor.  This document
  6. describes how individual commands work - it is light on general usage.
  7. If you need to learn Emacs, look at the GNU, Goslings or Unipress Emacs
  8. manuals.
  9.  
  10. DOC FILE        What it covers
  11. --------        ------------------------------------------
  12. CMDS.DOC        Keys and what they are bound to.
  13. ME.DOC (this file)    ME built in commands.
  14. MEMUTT.DOC        The ME extensions to Mutt and ME system variables.
  15. MUTT.DOC        The Mutt programming language and Mutt compiler.
  16. ERRATA.DOC        Errata, machine specifics and philosophy.
  17. REGEXP.DOC        Regular expressions.
  18.  
  19. ========================================================================
  20. ==        What ME does NOT have that Emacs does                       ==
  21. ========================================================================
  22. * Undo
  23. * File name completion
  24. * Command history (mini buffer editing)
  25. * Multiple key macros, named macros, macros bound to keys
  26. * Recursive editing
  27. * Local syntax tables
  28. a few others
  29.  
  30. ========================================================================
  31. ==        Soft keys and Function keys                           ==
  32. ========================================================================
  33.  
  34.   When describing characters or keys, the character itself is used if it
  35. is printable.  Unprintable characters are made printable using 3 or more
  36. printable characters.  For example, the letter "A" is printable but
  37. control-A is not and so the code "C-A" is used to describe it.  The
  38. table below shows the various codes needed to map the unprintable keys.
  39.  
  40. Prefix    Meaning
  41.   C-    Control key.
  42.   F-    Function or soft key such as f1, Home, etc.
  43.   M-    Meta key.  See META in the GLOSSARY.
  44.   S-    Shift.  This only applies to function keys.
  45.  
  46.    This is a list of  "extended"  keys - those not covered by ASCII.  ME
  47. maps  these keys to 3 or more  ASCII  codes.  Ignore  the ME key  column
  48. unless  you are  binding  keys.  The  keyboard  column is the key on the
  49. keyboard you press to generate the ME key which (unless  rebound)  fires
  50. off the function listed in the Bound to column.
  51.  
  52. keyboard      ME key    Bound to
  53.    F1        F-1
  54.    F2        F-2
  55.    F3        F-3
  56.    F4        F-4
  57.    F5        F-5
  58.    F6        F-6
  59.    F7        F-7
  60.    F8        F-8
  61.    F9        F-9
  62.    F10        F-0
  63.   home        F-A    (beginning-of-buffer)
  64.   end        F-B    (end-of-buffer)
  65.   up arrow    F-C    (previous-line)
  66.   down arrow    F-D    (next-line)
  67.   right arrow   F-E    (next-character)
  68.   left arrow    F-F    (previous-character)
  69.   insert    F-G
  70.   delete    F-H    (delete-character)
  71.   page up    F-I    (previous-page)
  72.   page down    F-J    (next-page)
  73.   clear line    F-K    (kill-line)
  74.   delete line    F-L
  75.   insert line    F-M
  76.   select    F-N    (set-mark)
  77.   roll up     F-O    (scroll-down)
  78.   roll down     F-P    (scroll-up)
  79.   DEL        ^?    (delete-character)
  80.   ESC        ^[
  81.   shift tab    M-I
  82.  
  83.   ALT 0..9A..Z!    mapped to META 0..9A..Z!
  84.   Use the ALT key like the control key (ie hold it down while you press the
  85.     next key).
  86.  
  87. ========================================================================
  88. ========================================================================
  89.  
  90. Anytime you are being queried on the message line the softkeys return
  91. their internal value.  So if you want to bind F1, you can press F1
  92. when bind-to-key asks for a key.
  93.  
  94. Case of letters:
  95.   Meta keys and Control X commands: next letter is ALWAYS uppercase.
  96.   Softkeys are case sensitive.
  97.  
  98. ========================================================================
  99. ==            GLOSSARY                      ==
  100. ========================================================================
  101. ^[  See META
  102. args
  103.   Parameters or arguments that will be requested by the command.  If
  104.    [] surround the arg, then it will only be requested in certain cases.
  105. binding    See bound.
  106. bound
  107.   A key is attached or bound to a command or program.
  108.   If the key is pressed, whatever it is bound to is invoked.
  109.   Keys can be bound locally or globally.  If a key has a local  binding,
  110.     pressing  the key in the  buffer  it was bound in causes  action.  A
  111.     global  binding  covers all buffers.  Note that local  bindings take
  112.     precedence over global ones.
  113. buffer
  114.   A buffer is the  internal  workspace.  If a buffer is  visible,  it is
  115.     shown through one or more windows.  It is usually attached to a file
  116.     (ie  contains  the contents of the file).  If the buffer was created
  117.     by reading in a file, the  buffer  name is created by  removing  the
  118.     path from the file name (and leaving only the name and extension).
  119. command or cmd
  120.   A ME built in command such as (search-forward).
  121.   These can be bound to a key to make executing them easier.
  122.   Documented  under  COMMANDS  (in  ME.DOC).  These are  different  from
  123.     functions  in  that  they  can be  bound  to  keys  or  executed  by
  124.     (ME-command).
  125. Command  completion
  126.   ME will  attempt to complete a command if the space bar is pressed and
  127.     completion is on.  The only time you can use command  completion  is
  128.     when you are being queried in the  minibuffer.  For example, when ME
  129.     is requesting a buffer name for  (use-existing-buffer) and foobar is
  130.     a buffer,  typing  "foo" and hitting  space will fill in the rest of
  131.     the name.  ME also trys to fix typos.  If you had typed  "fooie" and
  132.     hit the space bar, you still get "foobar".  Sometimes,  you will hit
  133.     space and only part of the command  name will  appear.  This is ME's
  134.     way of  telling  you there is some  ambiguity  as to the full  name.
  135.     Type some more of the name and hit space  again or press ?  to get a
  136.     list of possible names.
  137.   See also: complete in MEMUTT.DOC.
  138. dot
  139.   The place between two  characters.  It is  immediately  to the left of
  140.     the cursor.  Also known as point.  One per window or buffer.
  141. ESCAPE  See META
  142.   The escape key (usally marked ESC on keyboards) acts like the META key
  143.     for those keyboards that don't have a META key.
  144. file
  145.    For MS-DOS, you can use forward slashes "/" as part of the path name.
  146. function or fcn
  147.   The commands that comprise the Mutt programming  language.  Documented
  148.     in MUTT.DOC and MEMUTT.DOC.  These differ from commands in that they
  149.     cannot be bound to keys and cannot be executed by (ME-command).
  150. help
  151.    Help is pretty much limited to reading manuals or asking gurus.
  152.    Limited  forms of online help are  command  completion  (see  above),
  153.      typing a ?  when  being  asked a  question  (see "If you are  being
  154.      asked a question" below) and (describe-bindings).
  155. keys
  156.   Keys are used to enter text and invoke commands.  The keys used to
  157.     invoke can be one or two keys where each key can have one or more
  158.     modifiers.
  159.     modifier meaning    notes
  160.        M-    META    See META and ESCAPE.  Cannot be prefixed.
  161.        C-    CONTROL    
  162.        S-    SHIFT    Only used with nonASCII keys
  163.        F-    FUNCTION    NonASCII keys
  164.   See also: prefix-key in MEMUTT.DOC
  165. Kill buffer
  166.   An invisible buffer that holds things created by deletion commands
  167.     such as (kill-region) and (copy-region).  Used to cut and paste, or
  168.     just cut, text.
  169.   If you want to move a block of text about: 1. set the mark at one end
  170.     and then move the dot to the other end.  2. kill the region. 3. move
  171.     the dot to the start of where you want the text to begin and 4. yank
  172.     the kill buffer.  Bingo.
  173.   Copy and kill append to the kill buffer if last command was also a
  174.     kill or copy, otherwise the kill buffer is cleared before the new text
  175.     is entered.
  176.   The killbuffer is also used by (filter-region).
  177. macro
  178.   A sequence of  keystrokes  that can be replayed on command.  Used when
  179.     you don't  want to spend  the time  writing a  program.  Created  by
  180.     going through the motions (which are actually done so you can verify
  181.     that  what  you  want  to  happen  is   actually   happening)   (see
  182.     (start-macro)  and (end-macro)).  When replayed by  (execute-macro),
  183.     the exact sequence you typed in is reentered.
  184. mark
  185.   A user s